docs(readme): point the inbox at the chat adapter - #20
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs note only. No code change, no API change, no release.
Task 35 added a chat adapter to the TypeScript and Python SDKs: it wraps the inbox conversation and reply endpoints in a send/receive interface for chatbot frameworks. There is no dedicated adapter in this client and none is planned, but nothing stops you writing the same loop with it, so the README now says how.
The new
Chatbots and the inboxsection covers the three pieces: verify theinbox.message_receivedwebhook (the payload is ids only, on purpose), read the item back through the inbox, then answer with the reply endpoint or open a thread. Reading needs theinboxscope; answering needspublishas well.Every method name in the section was checked against this SDK on the rebased branch.
Full walkthrough: https://fopost.com/docs/sdks/chat-adapter (fopost/fopost-docs#73 merges first).